home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1993 November / JCSM Shareware Collection - 1993-11.iso / cl560 / hdk90a.lzh / HLPDK.DOC < prev    next >
Text File  |  1993-08-26  |  48KB  |  1,006 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. * HLPDK- Help Engine Dev. Kit : helpEng Doc V9.0                              *
  13. * LAST UPDATE - Aug. 26, 1993. (c) 1992,93 - Loewy Ron.                       *
  14. *******************************************************************************
  15.  
  16.  
  17.  
  18.         RL Help Engines.
  19.         
  20.         Help Compiler, Run-Time help engines and docs.
  21.  
  22.         Support for Dos, OS/2, DESQview/X & Windows.
  23.         Creates Documentation (Text, WP) from the same source.
  24.  
  25.         Supported Formats :
  26.  
  27.         Native(PX), Native(Mem), Win30, Win31, QuickHelp, 
  28.         THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, RTF (Word Processors)
  29.  
  30.         "Write Once, Help Many!"
  31.  
  32.                    
  33. *******************************************************************************
  34. *                                  File-List                                  *
  35. *******************************************************************************
  36.  
  37.  This package contains the following files in the following archives :
  38.  
  39. Archive A :
  40. -----------
  41.  READMEA.HDK    - File List for Archive A.
  42.  HELPC.EXE      - Help Compiler.
  43.  HLPDK.DOC      - This file.
  44.  HELPC.DOC      - Help Compiler documentation
  45.  HLPDK.REG      - Registration file.
  46.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  47.  HLPDK.HLP      - WinHelp Version of the hlpdk hypertext source.
  48.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  49.  HELPDEMO.HDF   - Demo Help Project.
  50.  2NDDEMO.HDF    - Demo Help Project - file 2.
  51.  
  52. Archive B :
  53. -----------
  54.  READMEB.HDK    - File List for Archive B.
  55.  HELPENG.EXE    - Help Engine (Native Paradox).
  56.  HE.EXE         - Help Engine (Native Memory).
  57.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  58.  HLPDK.HDT      - Help Development Kit help database file. (Native Paradox)
  59.  HLPDK.SET      - Help Development Kit help database file.
  60.  HLPDKTOP.*     - Help Development Kit help database files.
  61.  HLPDKLNK.*     - Help Development Kit help database files.
  62.  HLPDKKEY.*     - Help Development Kit help database files.
  63.  
  64. *******************************************************************************
  65. *                                Why Register                                 *
  66. *******************************************************************************
  67.  
  68.   The Help Engine Development Kit (HLPDK) is a shareware product, 
  69.  if you find this product valuable, please register it. 
  70.  This section describes the reasons you should register.
  71.  
  72.   By registering you will receive a complete discussion
  73.  of the help engine features, and many examples of usage. You will receive a 
  74.  diskette with the latest HLPDK version, and DPMI (dos protected mode)
  75.  versions of the help compiler and engines!. (The memory version of the
  76.  help engine can display huge databases only in the protected mode
  77.  version).
  78.  
  79.   Your registration will help us to create the next versions of HLPDK, that
  80.  will include more options, and features, some of them might even be your
  81.  enhancement requests!.
  82.  
  83.   A point to consider - If you want to create Windows Help source files,
  84.  you will have to purchase a word processor that can output RTF files,
  85.  the WORD for Windows 2.0 package, for example, is listed at around $500!.
  86.  
  87. *******************************************************************************
  88. *                                  What's New                                 *
  89. *******************************************************************************
  90.  
  91.   Version 9.0
  92.  
  93.         - Added support for automatic group menu generation. Use this feature
  94.           to associate sets of topics to groups, and create menus of these  
  95.           groups in different places.
  96.  
  97.         - To support the groups functions, the .GROUPS and .INSERT GROUP 
  98.           statements were added to the HDF syntax. Please refer to the
  99.           helpc.doc documentation for discussion of these statements.
  100.  
  101.         - Improved character format control. From this version you can specify 
  102.           text attributes on the paragraph start statement, to choose the 
  103.           font, size etc .. of the paragraph text. This support is currently
  104.           available to winhelp and rtf targets, in the other targets, these
  105.           attributes are ignored. Please refer to helpC documentation for
  106.           further discussion of this feature.
  107.  
  108.         - Added the .SETFONT command to the HDF syntax. Use this command to
  109.           change or add new fonts to the font pallete.
  110.  
  111.         - Added the .TITLEATTR topic attribute to the .HDF syntax, use this
  112.           statement to define text attributes to the topic title. Please refer
  113.           to the helpC documentation about this feature.
  114.  
  115.         - Added the .TITLEDEFAULTS statement to the .HDF syntax. Use this 
  116.           command to set default attributes to all the topic titles. These
  117.           defaults can be over-ridden with the .TITLEATTR statement described
  118.           above.
  119.  
  120.         - Added the .INSERT CODE and .END-CODE statements, use these statements
  121.           to insert target code in your .HDF sources. Code inserted between 
  122.           these 2 statements is sent to the output file with no translation
  123.           by helpC.
  124.  
  125.         - Replaced the helpC /D, /L, /H and /K switches with /ND:, /NL:, /NT:
  126.           and /NK: - The new switches were needed because of the number of 
  127.           options that should be specified on the command line, as well as 
  128.           the fact that they are easier to  remember now.
  129.  
  130.         - Added the ability to define a conditional define on the command
  131.           line of the helpC compiler, using the /D: switch.
  132.  
  133.         - Added the .ATTRDEDAULTS statement to the .HDF syntax. Use this 
  134.           statement to set the default paragraph attributes. Please refer
  135.           to the helpc.doc file for documentation on this function.
  136.  
  137.         - If no default font or attribute is set in the winhelp and rtf
  138.           targets Times New Roman is the default font vs. Tms Rmn in previous
  139.           version.
  140.  
  141.         - Added the .EXT-TOPIC topic definition statement. This statement 
  142.           defines a topic (like the other topics defined with .TOPIC/.ENTRY 
  143.           etc..), and also creates an external reference to that topic to
  144.           be called from an external program.
  145.  
  146.         - Added the /ED= switch to the helpC command line. /ED=P (Default)
  147.           creates the external definitions (if any) in a pascal unit format,
  148.           /ED=C creates the external definitions in a C/C++ header file.
  149.  
  150.         - Added the DOCUMENT conditional define if /RTF ot /TXT attributes
  151.           are set. This way you can easly set document text for both targets.
  152.  
  153.         - In pophelp (/PH+) target, the !INDEX directive is added, so topics
  154.           are ordered in the main index file in the order they appear in the
  155.           source HDF file.
  156.  
  157. *******************************************************************************
  158. *                                Introduction                                 *
  159. *******************************************************************************
  160.  
  161.   The Help Engine Development Kit is a system that allows you to create 
  162.  hyper-text database help systems with topics and hot links, using a simple
  163.  text editor and the help compiler. 
  164.  
  165.   The help databases can be distributed (free of charge) with the HELPENG or
  166.  HE help engine display programs. 
  167.  
  168.   The help database format is release to the public domain, if you own the 
  169.  Paradox Engine you can use the help databases with your own programs. 
  170.  
  171.   Borland Pascal Users can purchase the Help Engine Source Code even
  172.  for Applications that do not use the paradox engine, using the Native Mem
  173.  format.
  174.  
  175.   The helpC compiler that is part of this development kit includes the
  176.  ability to create Windows Help source files from the same source the 
  177.  dos help sources are created!. Write your help once, and create help
  178.  databases for Dos, Windows, OS/2 and DESQview/X !
  179.  
  180.   From the same source you created your hypertext database, you can create
  181.  a text document with automatic table of contents, glossary and index sections!
  182.  
  183.   Using the RTF target you can prepare your proffesional documentation
  184.  by generating word processors documents, all from the same source!
  185.  
  186.   Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  187.  Turbo Pascal programs, and use the help engine window in your pascal
  188.  programs.
  189.  
  190. *******************************************************************************
  191. *                                    Setup                                    *
  192. *******************************************************************************
  193.  
  194.   Copy the files in this package to a directory of your choice.
  195.  
  196. *******************************************************************************
  197. *                                 Quick Start                                 *
  198. *******************************************************************************
  199.  
  200.   From the command line enter HELPC HELPDEMO to compile the demo help database.
  201.  
  202.   After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  203.  demo help database.
  204.  
  205.  If you want to compile for windows :
  206.  
  207.  from the command line enter HELPC HELPDEMO /W31
  208.  and after that HC31 HELPDEMO
  209.  (HC31 is the Microsoft Help Compiler)
  210.  from windows, open the HELPDEMO.HLP file from the windows help engine.
  211.  (Notice - if you do not have the HC help compiler from windows, we have
  212.   included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  213.   able to feel the quality of the output that can be generated, and decide
  214.   if you want to purchase the HC31 program (Included with the SDK, BC++, 
  215.   TPW, BP and probably some other packages), or download it from one of the 
  216.   sites Microsoft had uploaded it to).
  217.  
  218.  If you use windows 3.0, or want your help file to be compatible with
  219.  winHelp 3.0 use :
  220.         HELPC /W30 HELPDEMO
  221.         HC HELPDEMO
  222.  
  223.  To compile for THELP use : 
  224.         HELPC /TH+ HELPDEMO
  225.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  226.  
  227.  To compile for QuickHelp : 
  228.         HELPC /QH+ HELPDEMO
  229.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  230.  
  231.  To compile for TVHC :
  232.         HELPC /TV+ HELPDEMO
  233.         TVHC HELPDEMO.TXT
  234.  
  235.  To compile for POPHELP :
  236.         HELPC /PH+ HELPDEMO
  237.         MAKEHELP /Q HELPDEMO
  238.  
  239.  To compile for DESQview/X :
  240.         HELPC /XD+ HELPDEMO
  241.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  242.         COPY HELPDEMO.HLP d:\DVX\HELP
  243.  
  244.  To compile for Native Mem Format :
  245.         HELPC /MT+ HELPDEMO
  246.  (Use HE HELPDEMO to view that database).
  247.  
  248.  To compile for IPF (OS/2) format :
  249.         HELPC /OS2 HELPDEMO
  250.         Switch to an OS/2 session.
  251.         IPFC /INF HELPDEMO
  252.  (Use the VIEW Command to browse the database).
  253.  
  254.  To create a text document with table of contents, glossary and index :
  255.         HELPC /TXT HELPDEMO
  256.  
  257.  To create a word processor document with table of contents, 
  258.  glossary and index :
  259.         HELPC /RTF HELPDEMO
  260.         import helpdemo.rtf to your word-processort, and update fields.
  261.         (e.g. Microsoft WinWord : File|Open to open the document
  262.                                   Answer Yes to convert from Rich Text Format
  263.                                   Press F9 to update embedded format fields 
  264.                                   somewhere in the first page (after the 
  265.                                   Table Of Contents title), and in the last 
  266.                                   page (after the index title).)
  267.  
  268. *******************************************************************************
  269. *                                  Operation                                  *
  270. *******************************************************************************
  271.  
  272.   To start the help engine program enter HELPENG on the command line, and 
  273.  choose the help database you want to view from the list box. Use the Tab key
  274.  to cycle between hot-link words, and press Enter to go to that link.
  275.  
  276.   If you know the name of the SET file of the database you want to activate, you
  277.  can enter it on the command line, and the help engine will display it.
  278.  
  279.   If you have a mouse, you can use it to point at the hi-lighted links, and 
  280.  activate them by pressing the left mouse button.
  281.  
  282.   Press the ALT-T key combination to choose from a list of TOPICS in the 
  283.  database, Press ALT-B to go back to the previous displayed TOPIC, Press
  284.  ALT-X to exit the help engine.
  285.  
  286.   The exit command can be given by pressing the right mouse button.
  287.  
  288.   Use F10 to open the menubar, and use the arrow keys to navigate the 
  289.  options. When you find the option you are interested in, Use the Enter
  290.  key to execute it, or the Esc key to cancel. The menubar can be navigated
  291.  using the mouse as well.
  292.  
  293.   To create a new help database please refer to the HELPC documentation
  294.  file.
  295.  
  296.   If you want to use the Native Mem Format Databases, Please use the supplied
  297.  HE.EXE program. 
  298.  
  299. *******************************************************************************
  300. *                                  Warranty                                   *
  301. *******************************************************************************
  302.  
  303.   There is no warranty what so ever, The package is supplied as is,
  304.  The distributor (ISoft D&M), or the author (Loewy Ron), are not, 
  305.  and will not be responsible for any damages, lost profits, 
  306.  or inconveniences caused by the use, or inability to use this package. 
  307.  The use of the program is at your own risk. 
  308.  By using (or attempting to use) the package you agree to this.
  309.  
  310. *******************************************************************************
  311. *                                   General                                   *
  312. *******************************************************************************
  313.  
  314.   HLPDK is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
  315.  
  316.   HLPDK is (c) copyrighted by Loewy Ron, 1992, 93.
  317.  
  318.   HLPDK is a shareware program, please register your copy. 
  319.   To register your copy of HLPDK please refer to the supplied
  320.   HLPDK.REG file. 
  321.  
  322.   Other programs distributed by ISoft D&M are described in the supplied  
  323.   PROGRAMS.TXT file.
  324.  
  325.  
  326. *******************************************************************************
  327. *                                   Contact                                   *
  328. *******************************************************************************
  329.  
  330.   Please contact :
  331.  
  332.   ISoft D&M,  
  333.   P.O.B 5517
  334.   Coralville IA 52241,
  335.   U.S.A
  336.  
  337.   ISoft D&M e-mail address : CompuServe - 76350,333
  338.  
  339.   To contact the author directly : 
  340.  
  341.   Contact :     Loewy Ron,
  342.                 9 Haneveem st.
  343.                 Herzeliya, 46465
  344.                 ISRAEL.
  345.  
  346.   e-mail address : CompuServe - 100274,162
  347.  
  348. *******************************************************************************
  349. *                              Trouble Shooting                               *
  350. *******************************************************************************
  351.  
  352.   If you receive some kind of an error message while using the help development
  353.  kit please refer to this section.
  354.  
  355.  tableOps: xxxx error message :
  356.  This message is generated by the Paradox Engine if an internal error occurs,
  357.  if you receive a message that is not understood (e.g. Table is busy), 
  358.  please try one of the following :
  359.  1. Try running the Help Compiler or the Help Engine with another input and 
  360.     notice if the problem exists, if it does, turn to the next entry,
  361.     otherwise try to see what the difference between the inputs is.
  362.  2. Check your free memory, try to move some TSR's from memory, or use the
  363.     protected mode compiler/engine available with the registered version.
  364.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  365.     with programs that use the Paradox Engine. If you receive a table busy
  366.     error, try to see if you have another program that uses the same table 
  367.     in another session (Windows/DESQview etc..).
  368.  4. PANIC - Please contact the distibuter/author for additional help.
  369.  
  370.  Microsoft's HC31 help compiler will generate a error in RTF file error :
  371.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  372.     still exists - please try steps 2 and 3, and notify the author. 
  373.  2. Use a binary disk editor to look at the character at the position x - 1
  374.     in the RTF file (where x is the error position reported by HC31).
  375.  3. Try to replace that charqacter from a special PC oem character to a 
  376.     "standard" ascii character (such as *). If the problem still occurs,
  377.     please contact ISoft D&M/The author, otherwise - you probably came 
  378.     accross a character that HC31 can not handle. In that case - try using
  379.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  380.     characters from your source HDF file.
  381.  
  382.  Borland's HL help linker will generate a FE02: Out Of Memory error :
  383.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  384.     screen's definitions.
  385.  
  386.  Borland's HL help linker will complain about undefined context numbers :
  387.  1. You probably have a contents.h file in the current directory, that hl
  388.     tries to use to bind the help topics to Borland's IDE on-line help,
  389.     try renaming this file, and re-compile with HL.
  390.  
  391.  HelpC will not create the database when compiling to Native Mem (/MT+) :
  392.  1. Try compiling with report generation on (/R+) to Native Paradox
  393.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  394.     them, and re-try.
  395.  2. If the database is BIG, you might not have enough memory - Remember that
  396.     Native Mem tables are generated in memory. You will have to use the
  397.     HelpCX protected mode compiler (Available with the registered version).
  398.  
  399.  HelpEng/HE will complain on an old-database when tring to open a help
  400.  database with it :
  401.  1. Re-Compile the database using helpC.
  402.  
  403.  HelpEng/HE will complain on un-supported database format, when trying to
  404.  open a database :
  405.  1. HelpEng can not display Native Mem databases, and HE can not display
  406.     Native PX databases. Use the other help engine supplied.
  407.  
  408.  HE will not be able to open a Native Mem database :
  409.  1. Use the protected mode HEX help engine. (Available for registered users).
  410.  
  411.  Where is HL - Borland's Help Linker :
  412.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
  413.     aditional package called Borland Open Architecture (and Borlad OA for 
  414.     Pascal) that include among other things - the THELP help linker.
  415.  
  416.   We have encountered some users that ran into problems, because they did 
  417.  not use the dos SHARE program. We advise that you will always load the 
  418.  SHARE program in your AUTOEXEC.BAT file.
  419.  
  420. *******************************************************************************
  421. *                              Related Products                               *
  422. *******************************************************************************
  423.  
  424. The following products/packages provide additional HLPDK functionality :
  425.  
  426. 1. Name         : IL2HDK - Interrupt List (Ralf Brown) 2 HLPDK convert program. 
  427.    Version      : 2.0
  428.    Availability : IL2HDK20.ZIP.
  429.    Status       : Free. 
  430.    Author       : Ron Loewy.
  431.  
  432. 2. Name         : HPCHDK - HelpPC 2 HLPDK convert program.
  433.    Version      : 1.0
  434.    Availability : HPCHDK10.ZIP.
  435.    Status       : Free.
  436.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  437.  
  438. 3. Name         : SCANHELP - Turbo Pascal Scanner to help.
  439.    Version      : 3.01
  440.    Availability : ? (Contact Author)
  441.    Status       : Shareware.
  442.    Author       : Duncan J. Murdoch (dmurdoch@mast.QueensU.CA)
  443.  
  444. 4. Name         : NG2HDK - Norton Guides 2 HLPDK convert program.
  445.    Version      : 1.0
  446.    Availability : NG2HDK10.ZIP
  447.    Status       : Free.
  448.    Author       : Ron Loewy.
  449.  
  450. 5. Name         : NEWSDB - News Clips Hypertext system.
  451.    Version      : Beta.
  452.    Availability : Not in GA yet. (I hope it will be around in Sept - Oct.).
  453.    Status       : To Be Determined.
  454.    Author       : Ron Loewy.
  455.  
  456. 6. Name         : POPHDK - POPHELP 2 HLPDK convert program.
  457.    Version      : 1.0
  458.    Availability : POPHDK10.ZIP.
  459.    Status       : Free.
  460.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  461.  
  462. *******************************************************************************
  463. *                                   History                                   *
  464. *******************************************************************************
  465.  
  466.  
  467.   Version 1.0 
  468.  
  469.         - First Version, Written for TXS V3.0 help system, 
  470.           as part of the WTGEN project, and generalized.
  471.  
  472.   Version 1.1
  473.  
  474.         - The Help Engine ALT-X (EXIT) command restores the screen
  475.           upon termination.
  476.  
  477.         - Added /R switch for the helpC help compiler.
  478.  
  479.         - From this version the helpC compiler can generate source
  480.           files for the Microsoft help compiler (HC) from the
  481.           SAME source .HDF). If the /w+ switch is specified,
  482.           the helpC compiler will create a .HPJ and .RTF files
  483.           to create the Windows .HLP file.
  484.  
  485.         - Includes a compiled version of the help demo database for
  486.           Windows WINHELP program. (View this if you do not have the
  487.           Microsoft HC Windows Help Compiler, to see the output that
  488.           can be generated with the helpC compiler, as a source to the 
  489.           HC compiler).
  490.  
  491.   Version 1.2
  492.  
  493.         - Windows RTF files will now display special characters ({, }, \),
  494.           by prefixing them with the RTF over-ride character (\), when the
  495.           /W+ switch is given to the helpC compiler.
  496.  
  497.         - helpC and helpEng were converted from TP6 to BP7.
  498.  
  499.         - The help engine and help compiler use the Paradox Engine V3.0 from
  500.           this release. (No need to keep your old PXENGINE.OVL file anymore).
  501.  
  502.         - Added the /W30 and /W31 switches to the helpC compiler. Use these
  503.           switches to set the output for the HC30 and HC31 Microsoft Windows
  504.           help compilers.
  505.  
  506.         - The help window scroll bars are are shown after a link is executed.
  507.           (A bug fix).
  508.  
  509.         - Added "Trouble Shooting" section to this document.
  510.  
  511.         - helpC and helpEng have DPMI versions to handle large projects.
  512.           (Available only with the registered version).
  513.  
  514.   Version 2.0
  515.  
  516.         - The help engine will display a new topic from the first line, and
  517.           not from the place that shows the current active link.
  518.  
  519.         - The help window in the help engine program can now be scrolled to
  520.           regions of the help topic, that do not include the current, or
  521.           any link.
  522.  
  523.         - A mouse click on a link, when the left-column is not 1 is recognized
  524.           as it should be.
  525.  
  526.         - The helpC help compiler will recognize .TOPIC and .END-TOPIC as
  527.           topic declaration keywords, as well as the .ENTRY and .END-ENTRY
  528.           that were used until this version.
  529.  
  530.         - The help topic table has a new field in it - the title field, using
  531.           this field you can specify the title of the help window, when it
  532.           displays a topic. Because of this field, databases created with
  533.           older versions of the help development kit will have to be 
  534.           re-compiled. (Please refer to HELPC.DOC).
  535.  
  536.         - The helpC help compiler will accept .TITLE keyword after the
  537.           .ENTRY (.TOPIC) line, to define a title to a topic window.
  538.  
  539.         - Added support for Microsoft Quick Help sources, and Borland THELP
  540.           sources generation.
  541.  
  542.         - The helpC compiler will translate ~~ in the source help definition
  543.           into a ~ sign in the help database. (In versions 1.x you could not
  544.           include the ~ sign in your help output text).
  545.  
  546.         - The help engine will except ALT-B as the go-back short-cut - to
  547.           display the previous help screen.
  548.  
  549.   Version 2.1 
  550.  
  551.         - I received several complaints that the HC31.EXE winHelp help compiler
  552.           does not work, and aborts at a specific place (byte 0x122) on the 
  553.           RTF file created by running HELPC /W31 HLPDK. It seems that for some
  554.           reason the HC31 compiler is not able to process all of the ascii 
  555.           characters. The ╔ character that appeared in byte offset 0x121
  556.           caused the HC31 compiler to abort. I do not know why this is 
  557.           a problem, I will try to investigate, and if I can not come with an
  558.           answer - I will try to contact microsoft (hey folks - they wrote it)
  559.           and find out. In the mean while - the HLPDK.HDF file provided with
  560.           this package - can be compiled by the HC31 compiler.
  561.  
  562.         - I have noticed that not all of the .HL files generated for THELP
  563.           users work. I must admit I can not find the reason, I will continue 
  564.           to investigate. I must admit it looks like a problem with the HL
  565.           docuimentation I have. In the mean while - please continue to
  566.           investigate the help development kit, and inform me of any 
  567.           other problems you face with it.
  568.  
  569.         - You can contact me (NEW NEW NEW) on my NEW (did I say that ..)
  570.           Compuserve Address : 100274,162
  571.           from internet that is : 100274.162@compuserve.com . 
  572.           Please send any enhancement requests, bug reports or other things - 
  573.           I'm currently in the process of planning the next major version,
  574.           and any input will be helpful.
  575.  
  576.         - QH (quickHelp) files will now display backslash characters that 
  577.           appear in the source file, by pre-fixing them with the over-ride 
  578.           character (\), when the /QH+ switch is given to the helpC compiler.
  579.  
  580.         - QH (quickHelp) links will now be visible, even when they are not
  581.           hi-lighted. These links will appear in BOLD face, by using the \b
  582.           bold source command.
  583.  
  584.         - For people interested in the HC help compiler - If you do not have
  585.           it in your development package (I was told that visual basic 
  586.           standard edition does not include it), you can download the 
  587.           3.0b version from CICA, in the winword directory.
  588.  
  589.         - NEW - Added TVHC Support - Use the /TV+ switch to create TVHC sources,
  590.           that you can compile using your version of TVHC (PASCAL or C++).
  591.  
  592.   Version 3.0
  593.  
  594.         - The THELP code generation was improved to support HL v6.10 that
  595.           comes as part of the Borland Pascal Open Architecture package.
  596.           Because of this change the following things should be noted :
  597.           1. The source screens inlude a ;INDEX directive, so HL will
  598.              not abort on FE02: Out Of Memory errors.
  599.           2. A new dummy screen that is needed for Borland Pascal IDE
  600.              is generated as the first screen in the soure .HL code.
  601.              You MUST compile the generate code using HL's -e switch,
  602.              specifing a number which is bigger then 1. HL will always
  603.              issue one error message - that screen DUMMY is not referenced,
  604.              this error should be ignored, the resulting .TPH/.TCH file
  605.              will be a valid THELP and IDE help file.              
  606.           3. HL V6.0 should still work, with better results, becasue the
  607.              Out Of Memory errors should be eliminated as well. (Do remeber
  608.              to use the -e switch with a value > 1).
  609.  
  610.         - The .TITLE directive cause titles to be generated for THELP
  611.           source now.
  612.  
  613.         - Added the .LINKCOLOR and .LINKHIGH commands in the Help Definition
  614.           File (.HDF) - that set the color of links in "normal" and 
  615.           hi-lighted states. This feature is relevant only when compiling
  616.           to native paradox engine (Help Engine) format.
  617.  
  618.         - Added the .INCLUDE commands to the .HDF specifications. Use this
  619.           help definition file command to create complex help projects that
  620.           are composed from multiple .HDF source files.
  621.  
  622.         - The helpC program will abort with an error message if no .end-topic 
  623.           command was supplied to the last topic in a .HDF file.
  624.  
  625.         - Added the ALT-T Topic Index command to the Help Engine. Use ALT-T
  626.           to display and choose from a list of all the topics in the help
  627.           database. For ease of use the topics are displayed with their titles.
  628.  
  629.         - Upon user's request - The ALT-X command will not have to be confirmed
  630.           by a TAB in order to exit the Help Engine.
  631.  
  632.         - Added support for the Search facility of WinHelp V3.x. From now on
  633.           the search button of windows help engine will display the list of
  634.           topic titles available in the help database.
  635.  
  636.         - Added the .FIXEDFONT command to the HDF syntax - use this command
  637.           to set the font used in the generated RTF file for WinHelp V3.x
  638.           to a fixed font. (By default a proportional font is used). If you
  639.           find that your help databases are not aligned after they are 
  640.           converted to winHelp format, use this command and re-compile.
  641.           This command has no effect on targets that are different from
  642.           windows winHelp formats.
  643.  
  644.         - The helpC compiler was converted to perform multiple passes on the
  645.           input data, if these passes are needed.
  646.  
  647.         - The maximum topic name length was expanded to 40 characters - this
  648.           means that V2.x help databases will have to be re-compiled for
  649.           this version.
  650.  
  651.         - Maximum Text displayed for a link was expanded to 60 characters.
  652.  
  653.         - The ALT-B HelpEng command has been enhanced to return to the position
  654.           viewed last.
  655.  
  656.         - Added POPHELP Source Generation. Use the helpC /PH+ parameter to
  657.           create source that can be used by TurboPower Software's makehelp
  658.           program - to create a pophelp .HLP file.
  659.  
  660.         - When generating code to winHelp source format, the helpC compiler
  661.           will issue a warning when an illegal HC link (topic) name is 
  662.           found, and will automatically convert this identifier to a name
  663.           that is supported by the HC compilers.
  664.  
  665.   Version 4.0
  666.  
  667.         - Help Source Generation is much faster in this version, when the
  668.           target is NOT the native format, and no Report is generated.
  669.  
  670.           In this case, helpC storage requirements will be much
  671.           smaller as well, because no paradox topic and link tables will
  672.           be created during the compile phase.
  673.  
  674.           Please notice that if POPHELP is the target, a temporary paradox
  675.           table will still be created, during pass 1 pre-processing, pass 2
  676.           however, will be much faster than what it was before.
  677.  
  678.           Compiling the hlpdk source on my 33MH 486 computer using 
  679.           helpc hlpdk /w30 /r- 
  680.           takes 1.76 sec. in V3.1 Vs. 5.23 sec. in V3.0.
  681.  
  682.         - Added the .PARAGRAPH .. .-END-PARAGRAPH paragraph markers in the
  683.           topic text section of the .HDF language. Use this feature to 
  684.           create long paragraphs that will be wrapped as one paragraph when
  685.           the help window is resized by the user. This feature is currently 
  686.           supported for winHelp code generation only.
  687.  
  688.           Please refer to the HELPC.DOC file for further discussion of this
  689.           text formatting feature.
  690.  
  691.         - Updated To Paradox Engine 3.01.
  692.  
  693.         - For easier development the .TOP and .ENDTOP commands are equivelent
  694.           to the .TOPIC and .END-TOPIC commands.
  695.  
  696.         - If no data file name is given to the helpC compiler, the set name
  697.           with target specific extention is given instead of the default
  698.           name given in previous versions.
  699.  
  700.         - If the help topics and link names are not specified, names that are
  701.           derived from the set name are given in this version, instead of the
  702.           default names that were given in previous versions.
  703.  
  704.         - Added support for long topic names, that include spaces in them.
  705.           Please refer to the HELPC.DOC file, regarding the /ST switch.
  706.  
  707.         - Added DESQview/X code generation support. Please refer to the 
  708.           HELPC.DOC File for the /XD+ HELPC Switch. In order to compile
  709.           the generated source you will have to use MDVXHELP, by 
  710.           Daniel J. Bodoh, that can be found in the file DVXHLP10.ZIP in
  711.           the DV-X directory on SIMTEL20, and probably some other places
  712.           on the internet, and other networks.
  713.  
  714.         - When generating code to THELP source format, the helpC compiler
  715.           will issue a warning when an illegal HL link (topic) name is 
  716.           found, and will automatically convert this identifier to a name
  717.           that is supported by the HL compiler.
  718.  
  719.         - Added the .PCFONT command to the HDF syntax - use this command
  720.           to set the font used in the generated RTF file for WinHelp V3.x
  721.           to a terminal font. (By default a proportional font is used). 
  722.           If you convert your help database that uses PC special characters,
  723.           and you want to preserve these characters in the windows version, 
  724.           use this statement.
  725.           This command has no effect on targets that are different from
  726.           windows winHelp formats.
  727.  
  728.         - When comiling to winhelp format, character with ordinal number 
  729.           bigger than 127 will be translated using the RTF override
  730.           mechanism. The "Famous" HC31 problem is over.. . (This solution
  731.           was offered by Mr. Lars Fosdal.)
  732.  
  733.         - When generating to winHelp Target, TAB characters are translated
  734.           to rtf \tab commands. For other targets no TAB translation is 
  735.           performed. It is advised that you set your editor to fill spaces
  736.           when a tab is inserted.
  737.  
  738.         - Added the /CS switch to the helpC compiler. Using this switch 
  739.           topics and links can be set to be case sensative. It is not advised
  740.           to use this switch, unless you want to create lower case indexes
  741.           in a help engine such as POPHELP or THELP. Please notice - setting
  742.           this switch to ON (+) can break help databases that used to compile
  743.           fine. Use With Care!. (By default case sensativity is set to off).
  744.  
  745.         - The HELPENG help engine can now handle topics with up to 500 lines,
  746.           vs. 125 in the previous version.
  747.  
  748.   Version 5.0
  749.  
  750.         - The helpC compiler will convert illegal winhelp 3.1 (HC31) characters
  751.           in titles to spaces. The previous version corrected only body text,
  752.           but did not detect illegal titles.
  753.  
  754.         - When THELP (HL) is the target, The OVERVIEW topic will be renamed to
  755.           Index - This is the name that MUST be attached to ;MainIndex screens
  756.           in THELP, if we want the IDE to display them as the main index.
  757.  
  758.         - The helpC compiler will look for a configuration file called 
  759.           HELPC.CFG in the current directory, and if it finds one will process
  760.           the switches in this file before any other command line switches.
  761.  
  762.         - Control Characters (ASCII < 32) are not acceptble by HC31 as well,
  763.           helpC will now create the RTF over-ride for these characters as
  764.           well.
  765.  
  766.         - Reports use virtual memory tables for cross reference manipulation,
  767.           so compile with report generation is faster. On my 486-33 computer
  768.           compiling HELPC HLPDK /W31 /R+ took 11 sec. in the previous version
  769.           Vs. 5 sec. only in this version. 
  770.  
  771.           As a side effect - the compiler will not create the helpct* temporary
  772.           tables. 
  773.  
  774.         - During Pass 1 of POPHELP and DV/X source generation - a temporary 
  775.           memory table will be used instead of a paradox table in previous
  776.           versions. Code generation will be both faster, and will not require
  777.           disk space for these targets. On my computer HELPC /R- /PH+ HLPDK 
  778.           takes 2.32 sec. Vs. 3.24 sec. on the previous version.
  779.  
  780.         - Added the .TEXTCOLOR command to the HDF syntax. Use this command to
  781.           set the value of the text color. This command is supported only
  782.           in the Native help format target.
  783.  
  784.         - Added The menu-bar to the helpEng help engine program.
  785.  
  786.         - The helpEng program can display multiple help windows.
  787.  
  788.         - Added the ability to save and print a help topic from within the
  789.           help engine.
  790.  
  791.         - Fixed a bug in the cross reference report that was cutting long
  792.           link names, and report on errors that did not exist.
  793.  
  794.         - A NEW Optimized Native help database format is introduced with this
  795.           version. The new Native Mem format uses Fast, Optimized code with
  796.           memory based indexes to display help faster, and with less 
  797.           distribution overhead. The HE.EXE Help Engine supplied with this
  798.           version is smaller in size than HELPENG.EXE, because it does not have
  799.           the Paradox Engine in it. The Help Databases Generated are smaller,
  800.           because the format is simple RAW Binary representation of the 
  801.           data structures handled in memory by the help engine.
  802.  
  803.         - The helpC compiler now supports the /MT+ switch to generate the
  804.           new Native Mem Format.
  805.  
  806.         - The Help Engine Source Code is now available to registered users,
  807.           (for additional cost) for the New Native Mem Format.
  808.  
  809.         - The Native Paradox Based format is still supported in this version,
  810.           and should be used to handle Huge help databases that will not fit
  811.           into memory, or to support PAL/ObjectPAL help applications from
  812.           within Paradox/Paradox for Windows. Use the helpC /PX+ switch to
  813.           generate code to this target. The HelpEng.EXE help engine is supplied
  814.           with this package as well.
  815.  
  816.   Version 6.0
  817.  
  818.         - The helpEng and HE help engines will not terminate abnormally when
  819.           the Print or Save Topic commands are given with an empty desktop,  
  820.           the help engine will issue a warning message and continue instead.
  821.  
  822.         - The Help Engines will restore the initial text cursor size upon 
  823.           termination. This was noticed by Prof. Timo Salmi of Vaasa, Finland.
  824.  
  825.         - Added the Navigate menu to the help engines. Use this menu's entries
  826.           to navigate the help database - choose from the overview screen, 
  827.           and index entries.
  828.  
  829.         - Added keyword support to help databases using the .KEYWORDS help
  830.           definition file syntax. Use this command to add multiple indexes,
  831.           or search by keywords to your help databases.
  832.           In this version of the helpC compiler, Native (/PX+, /MT+), winHelp 
  833.           (/W30, /W31) and THELP (/TH+) sources support the keyWords defined 
  834.           for topics. 
  835.           Please refer to the HELPC.DOC file for a formal discussion of this 
  836.           feature.
  837.  
  838.         - The set format file has been changed to support the keyword 
  839.           tables, old databases will have to be re-compiled for use with
  840.           the help engines.
  841.  
  842.         - Added the ALT-S (Search command) to the help windows in the HELPENG
  843.           program. Use this command to search on the keywords defined in the
  844.           help database.
  845.  
  846.         - Added OS/2 IPF source generation. Use the /os2 switch of the helpC
  847.           compiler to generate code to the OS/2 IPFC compiler. Paragraph 
  848.           support (.par .. .endpar/.paragraph .. .end-paragraph) is available
  849.           in this target as well.
  850.  
  851.         - The number of input lines displayed as processed by the helpC compiler 
  852.           include the actual number of input lines in the source HDF file, vs.
  853.           topic text lines only in the previous version.
  854.  
  855.         - helpC error reporting has been improved to include the line number
  856.           the error occured on.
  857.  
  858.   Version 7.0
  859.  
  860.         - The helpC compiler will perform RTF overrides in topic's names 
  861.           from this version. In previous versions if you had a character that
  862.           had to be overridden in a topic name, hot links could not access it,
  863.           because hot-links were overriden with a prefix '\' character, while
  864.           topic names were not.
  865.  
  866.         - Added the /WD switch to the helpC compiler. If you do not want to see
  867.           the information about topics and links that were translated in order 
  868.           to be compatible with the target source, turn Warning Display to Off
  869.           using /WD-
  870.  
  871.         - Added Conditional Defines to the compiler. Use the Conditional
  872.           define statements (.ifdef/.ifndef/.else/.endif) to compile different
  873.           parts of your source according to different defines. Please refer
  874.           to the HELPC.DOC file for a complete discussion of this important
  875.           feature.
  876.  
  877.         - Added the /TXT switch to the helpC compiler. Use this switch to
  878.           create a text document with page breaks, headers and footers from
  879.           your input source .HDF file. With this option the helpC compiler
  880.           allows you to create both on-line help and printed documentation
  881.           from the same source!
  882.  
  883.         - The /TXT format creates a Table Of Conbtents and Index files as 
  884.           well that you might want to print with your text document.
  885.  
  886.         - The Cross Reference Report format was improved to be displayed in 
  887.           80 columns. Link Error lines have been improved to include the 
  888.           link name for quick error diagnostic. D.J. Murdoch is the man
  889.           that suggested these enhancments.
  890.  
  891.         - The title string in the topics table has been expanded to 70 
  892.           characters. This was done to allow longer titles in /TXT /PX+ and
  893.           /MT+ targets. Old Native help databases will have to be re-compiled.
  894.  
  895.         - The help engines will be able to display topics of up to 16K lines,
  896.           vs. 500 only in previous versions.
  897.  
  898.         - The topic's title will be seen in winhelp's secondary (Go To) list
  899.           box of the search function, instead of the topic name that was used
  900.           in previous versions. Thanks for D.J Murdoch that noticed this
  901.           bug of mine.
  902.  
  903.         - Added .PAGELENGTH and .PAGEWIDTH statements to the .HDF syntax.
  904.           Use these statements to set the printed page size in /TXT targets.
  905.  
  906.         - A bug in winhelp's HCP that does not parse the RTF \tab statement has
  907.           been over-ridden by helpC that replaces TAB characters with a RTF
  908.           group that contains the \tab character.
  909.  
  910.   Version 8.0
  911.  
  912.         - Added the /RM switch to the helpC compiler. If you set this switch
  913.           off (/RM-) the cross reference temporary tables will be created on
  914.           disk instead of in memory. The disadvantage is that the report will 
  915.           be much slower, the advantage - you will need less memory for the 
  916.           compiler. When you try to compile huge databases, and do not have 
  917.           enough memory, use this option. (By default /RM is set to on /RM+).
  918.  
  919.         - Native format databases include a new field - tType of 1 character
  920.           in the topics table. This character is needed to support different 
  921.           types of topics. Databases from previous versions will have to be
  922.           re-compiled.
  923.  
  924.         - Added support for advanced word processors with the helpC /RTF
  925.           switch. Use this switch to create a version of documentation
  926.           that can be imported, with smart formatting options, by word
  927.           processors that support the RTF format. (Such as Microsoft Word
  928.           for Windows, Word Perfect for Windows and Lotus AMI PRO). With the
  929.           introduction of this option - you can create help database to 
  930.           multiple platforms, formatted text for "readme" computerized
  931.           documentation and professional word processor documentation from
  932.           the same source!.
  933.  
  934.         - Added the .POPUP and .END-POPUP (.ENDPOP) commands to the HDF syntax.
  935.           Use these commands to define popup definition topics. Popup 
  936.           definition topics are used as glossary entries that the user can
  937.           consult to see a definition without losing the current position
  938.           in the topic he is reading. POPUP entries are supported in the 
  939.           winhelp, Native Paradox and Native Memory formats. In the other 
  940.           targets, the popup entries are used as regular topics.
  941.  
  942.         - In the Text and RTF targets the popup entries will be converted to 
  943.           a glossary file/chapter, You can add this file as an appendix to your
  944.           document file.
  945.  
  946.         - Added a conditional define (NATIVE) when helpC /PX+, /MT+ targets
  947.           are chosen.
  948.  
  949. *******************************************************************************
  950. *                                   Credits                                   *
  951. *******************************************************************************
  952.  
  953.   HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  954.   Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  955.   (Trademarks of Borland International).
  956.  
  957.   Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  958.   of Microsoft Corp.
  959.  
  960.   The HELPENG program was written using the WINTEXT UI library, 
  961.   (c) 1991,93 Loewy Ron.
  962.  
  963.   THELP, HL and TVHC are Trademarks or copyrights Borland International.
  964.  
  965.   TVHC support, and other ideas were suggested by MunLeong Chan.
  966.  
  967.   POPHELP is a copyright of TurboPower Software.
  968.  
  969.   Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  970.   CASE code generators.
  971.  
  972.   Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  973.   code generator.
  974.  
  975.   Yaniv Golan helped me with beta-testing, debugging and suggestions.  
  976.   He is also the programmer of the HPC2HDK program (available in an archive 
  977.   site near you) that convert the HelpPC technical database to the Help 
  978.   Development Kit format.
  979.   (The HelpPC database is a wonderfull hypertext work by David Jurgens).
  980.  
  981.   John Murphy notified me of the paragraph formtting difficulties that
  982.   lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  983.  
  984.   DESQview/X is a trademark of Quarterdeck Office Systems.
  985.  
  986.   MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  987.   excelent documentation of DESQview/X help format to generate code
  988.   to this environment.
  989.  
  990.   The HC31 problem with characters with ordinal values biggen than 127
  991.   was solved thanks to Mr. Lars Fosdal of Norway.
  992.  
  993.   OS/2 is a registered trademark of International Bussiness Machines.
  994.  
  995.   The Text Cursor restore problem in the help engines was reported by Prof.
  996.   Timo Salmi of the Univ. of VAASA, Finland.
  997.  
  998.   D.J. Murdoch suggested the Cross Reference Report enhancments, and winhelp
  999.   Go To Search list box title problem.
  1000.  
  1001.   Word for Windows is a trademark of Microsoft corp.
  1002.  
  1003.   WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation.
  1004.  
  1005.   Lotus, AMI PRO are trademarks of Lotus corp.
  1006.